volumebutton: Convert docs
authorMatthias Clasen <mclasen@redhat.com>
Mon, 22 Feb 2021 00:43:00 +0000 (19:43 -0500)
committerEmmanuele Bassi <ebassi@gnome.org>
Thu, 11 Mar 2021 16:37:31 +0000 (16:37 +0000)
Change link syntax, add an example image, generally clean things up.

gtk/gtkvolumebutton.c

index feae0ca7907c30d931bd2ce50ad0a5ab4d312731..5d9c494a29c182097869383d7bef73aeb5d3b5b9 100644 (file)
 
 
 /**
- * SECTION:gtkvolumebutton
- * @Short_description: A button which pops up a volume control
- * @Title: GtkVolumeButton
+ * GtkVolumeButton:
  *
- * #GtkVolumeButton is a subclass of #GtkScaleButton that has
- * been tailored for use as a volume control widget with suitable
- * icons, tooltips and accessible labels.
+ * `GtkVolumeButton` is a `GtkScaleButton` subclass tailored for
+ * volume control.
+ *
+ * ![An example GtkVolumeButton](volumebutton.png)
  */
 
 typedef struct _GtkVolumeButtonClass  GtkVolumeButtonClass;
@@ -163,10 +162,10 @@ gtk_volume_button_class_init (GtkVolumeButtonClass *klass)
   /**
    * GtkVolumeButton:use-symbolic:
    *
-   * Whether to use symbolic icons as the icons. Note that
-   * if the symbolic icons are not available in your installed
-   * theme, then the normal (potentially colorful) icons will
-   * be used.
+   * Whether to use symbolic icons as the icons.
+   *
+   * Note that if the symbolic icons are not available in your installed
+   * theme, then the normal (potentially colorful) icons will be used.
    */
   g_object_class_install_property (gobject_class,
                                    PROP_SYMBOLIC,
@@ -194,11 +193,13 @@ gtk_volume_button_init (GtkVolumeButton *button)
 /**
  * gtk_volume_button_new:
  *
- * Creates a #GtkVolumeButton, with a range between 0.0 and 1.0, with
- * a stepping of 0.02. Volume values can be obtained and modified using
- * the functions from #GtkScaleButton.
+ * Creates a `GtkVolumeButton`.
+ *
+ * The button has a range between 0.0 and 1.0, with a stepping of 0.02.
+ * Volume values can be obtained and modified using the functions from
+ * [class@Gtk.ScaleButton].
  *
- * Returns: a new #GtkVolumeButton
+ * Returns: a new `GtkVolumeButton`
  */
 GtkWidget *
 gtk_volume_button_new (void)